<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>cat nodeattrs API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'cat-nodeattrs.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-nodeattrs.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-nodeattrs.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/cat-nodeattrs.html" rel="nofollow" target="_blank">../en/cat-nodeattrs.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="cat.html">cat APIs</a></span>
»
<span class="breadcrumb-node">cat nodeattrs API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="cat-master.html">« cat master API</a>
</span>
<span class="next">
<a href="cat-nodes.html">cat nodes API »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="cat-nodeattrs"></a>cat nodeattrs API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/nodeattrs.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Returns information about custom node attributes.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-nodeattrs-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/nodeattrs.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">GET /_cat/nodeattrs</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-nodeattrs-api-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/nodeattrs.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">format</code>
</span>
</dt>
<dd>
(Optional, string) Short version of the
<a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html" class="ulink" target="_top">HTTP accept header</a>.
Valid values include JSON, YAML, etc.
</dd>
<dt>
<span class="term">
<code class="literal">h</code>
</span>
</dt>
<dd>
<p>
(Optional, string) Comma-separated list of column names to display.
</p>
<p>If you do not specify which columns to include, the API returns the default columns in the order listed below. If you explicitly specify one or more columns, it only returns the specified columns.</p>
<p>Valid columns are:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">node</code>,<code class="literal">name</code>
</span>
</dt>
<dd>
(Default) Name of the node, such as <code class="literal">DKDM97B</code>.
</dd>
<dt>
<span class="term">
<code class="literal">host</code>, <code class="literal">h</code>
</span>
</dt>
<dd>
(Default) Host name, such as <code class="literal">n1</code>.
</dd>
<dt>
<span class="term">
<code class="literal">ip</code>, <code class="literal">i</code>
</span>
</dt>
<dd>
(Default) IP address, such as <code class="literal">127.0.1.1</code>.
</dd>
<dt>
<span class="term">
<code class="literal">attr</code>, <code class="literal">attr.name</code>
</span>
</dt>
<dd>
(Default) Attribute name, such as <code class="literal">rack</code>.
</dd>
<dt>
<span class="term">
<code class="literal">value</code>, <code class="literal">attr.value</code>
</span>
</dt>
<dd>
(Default) Attribute value, such as <code class="literal">rack123</code>.
</dd>
<dt>
<span class="term">
<code class="literal">id</code>, <code class="literal">nodeId</code>
</span>
</dt>
<dd>
ID of the node, such as <code class="literal">k0zy</code>.
</dd>
<dt>
<span class="term">
<code class="literal">pid</code>, <code class="literal">p</code>
</span>
</dt>
<dd>
Process ID, such as <code class="literal">13061</code>.
</dd>
<dt>
<span class="term">
<code class="literal">port</code>, <code class="literal">po</code>
</span>
</dt>
<dd>
Bound transport port, such as <code class="literal">9300</code>.
</dd>
</dl>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">help</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response includes help information. Defaults
to <code class="literal">false</code>.
</dd>
<dt>
<span class="term">
<code class="literal">local</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the request retrieves information from the local
node only. Defaults to <code class="literal">false</code>, which means information is retrieved from
the master node.
</dd>
<dt>
<span class="term">
<code class="literal">master_timeout</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to <code class="literal">30s</code>.
</dd>
<dt>
<span class="term">
<code class="literal">s</code>
</span>
</dt>
<dd>
(Optional, string) Comma-separated list of column names or column aliases used
to sort the response.
</dd>
<dt>
<span class="term">
<code class="literal">v</code>
</span>
</dt>
<dd>
(Optional, boolean) If <code class="literal">true</code>, the response includes column headings.
Defaults to <code class="literal">false</code>.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cat-nodeattrs-api-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/nodeattrs.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="cat-nodeattrs-api-ex-default"></a>Example with default columns<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/nodeattrs.asciidoc">edit</a>
</h4>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_cat/nodeattrs?v</pre>
</div>
<div class="console_widget" data-snippet="snippets/1362.console"></div>
<p>The API returns the following response:</p>
<div class="pre_wrapper lang-txt">
<pre class="programlisting prettyprint lang-txt">node    host      ip        attr     value
...
node-0 127.0.0.1 127.0.0.1 testattr test
...</pre>
</div>
<p>The <code class="literal">node</code>, <code class="literal">host</code>, and <code class="literal">ip</code> columns provide basic information about each node.
The <code class="literal">attr</code> and <code class="literal">value</code> columns return custom node attributes, one per line.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="cat-nodeattrs-api-ex-headings"></a>Example with explicit columns<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cat/nodeattrs.asciidoc">edit</a>
</h4>
</div></div></div>
<p>The following API request returns the <code class="literal">name</code>, <code class="literal">pid</code>, <code class="literal">attr</code>, and <code class="literal">value</code>
columns.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_cat/nodeattrs?v&amp;h=name,pid,attr,value</pre>
</div>
<div class="console_widget" data-snippet="snippets/1363.console"></div>
<p>The API returns the following response:</p>
<div class="pre_wrapper lang-txt">
<pre class="programlisting prettyprint lang-txt">name    pid   attr     value
...
node-0 19566 testattr test
...</pre>
</div>
</div>

</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="cat-master.html">« cat master API</a>
</span>
<span class="next">
<a href="cat-nodes.html">cat nodes API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>